Home Explore Help
Register Sign In
J1X
/
huginn
Watch 2
Star 0
Fork 0

Browse Source
the retrieval part of this agent

Judy Ngai 9 years ago
parent
6fdf53d694
commit
ebbfd6191f
1 changed files with 22 additions and 38 deletions
Show Diff Stats
  1. 22 38
      app/models/agents/aftership_agent.rb

+ 22 - 38
app/models/agents/aftership_agent.rb
View File 

@@ -4,45 +4,30 @@ module Agents
4 4 
   class AftershipAgent < Agent
5 5
6 6 
     API_URL = 'https://api.aftership.com/v4'
7 
-    HEADERS = {"aftership-api-key"=> "apikey", "Content-Type"=>"application/json"}
8 7
9 8 
     description <<-MD
9 
+      The Aftership agent allows you to track your shipment from aftership and emit them into events.
10 10
11 
-      The Aftership agent allows you to track your shipment data from aftership and emit them into events.
11 
+      To be able to use the Aftership API, you need to generate an `API Key`. You do need a paying plan to use their tracking feature.
12 12
13 
-      To be able to use the Aftership API, you need to generate an `API Key`.
14 
-      You can generate an api key by visiting `apps > app and click add` on aftership website.
13 
+      You need a key value pair to retrieve data. The key is `get_url`.
15 14
16 
-      The agent is limited to 600 reqs/min per account. You do need a paying plan to use their tracking feature.
15 
+      The options are `/trackings/export` to get tracking results for backup purposes, `/trackings/slug/tracking_number` to get tracking
16 
+      for a single tracking number and `/trackings` to get all of your trackings. You have two options to get courier information, `/couriers`
17 
+      which returns the couriers that are activiated at your account and the other is `/couriers/all` which returns all couriers.
18 
+      `slug` is a unique courier code which you can get from using this agent.
17 19
18 
-      If you are requesting tracking data from aftership. You have to put in a specific url for get_url in default options.
19 
-
20 
-      The options are `/trackings/export` to get tracking results for backup purposes, `/trackings/:slug/:tracking_number` to get tracking
21 
-
22 
-      for a single tracking number and `trackings` to get all of your trackings.
20 
+      The url must be properly formatted with a `/` in front.
23 21
24 22 
       Required Options:
25 23
26 24 
       * `Content-Type` application/json
27 
-      * `aftership_api_key` - YOUR_API_KEY.
28 
-      * `a certain request whether it be get or put or post`
25 
+      * `api_key` - YOUR_API_KEY.
26 
+      * `key value pair request`
29 27 
     MD
30 28
31 29 
     event_description <<-MD
32 
-      Events look like this:
33 
-
34 
-    {
35 
-      "meta": {
36 
-        "code": 200
37 
-      },
38 
-      "data": {
39 
-        "couriers": [
40 
-           { ... },
41 
-           { ... },
42 
-           { ... }
43 
-           ]
44 
-       }
45 
-     }
30 
+      It depends what kind of event that you are working on:
46 31 
       MD
47 32
48 33 
     def default_options
 
@@ -53,30 +38,29 @@ module Agents
53 38 
     end
54 39
55 40 
     def uri
56 
-      #there may be an updated version
57 
-      uri = URI.parse('https://api.aftership.com/v4')
58 
-      #uri.query = [uri.query, '/trackings' ].compact.join()
59 
-      uri.query = [uri.query, interpolated['get_url'] ].compact.join()
60 
-      uri.to_s.gsub('?','')
41 
+      uri = URI.parse API_URL
42 
+      uri.query = interpolated['get_url'] if uri.query.nil?
43 
+      uri.to_s.gsub('?','')
61 44 
     end
62 45
63 46 
     def working?
64 
-      !recent_error_logs?
47 
+      (events_count.present? && events_count > 0)
65 48 
     end
66 49
67 50 
     def validate_options
68 
-      #errors.add(:base, "You need to specify a aftership api key") unless options['aftership-api-key'].present?
51 
+      errors.add(:base, "You need to specify a api key") unless options['api_key'].present?
69 52 
       errors.add(:base, "Content-Type must be set to application/json") unless options['Content_Type'].present? && options['Content_Type'] == 'application/json'
70 
-      #only one put or request can be requested
53 
+      errors.add(:base, "You need to specify a certain request") unless options['get_url'].present?
71 54 
     end
72 55
73 
-    def request
74 
-      HTTParty.get(uri, :headers => HEADERS)
56 
+    def request_options
57 
+      {:headers => {"aftership-api-key" => interpolated['api_key'], "Content-Type"=>"application/json"} }
75 58 
     end
76 59
77 60 
     def check
78 
-      data = {"body" => request.body, "message" => request.message}
79 
-      create_event :payload => data
61 
+      response = HTTParty.get(uri, request_options)
62 
+      events = JSON.parse response.body
63 
+      create_event :payload => events
80 64 
     end
81 65 
   end
82 66 
 end